ゴミ箱の扱い変化に伴うAPIエンドポイントのパラメータ変更について #Notion

Notion API Changelogにて4月時点でAPIエンドポイントに関する告知がありました。エンドポイントのうち、archived が in_trashに代わるというものです。

単なるリネームに見えそうですが、Notionにおけるゴミ箱の扱いが変わった影響でもあります。

アーカイブから廃棄へ

今回の変更には削除扱いとなったデータに関する保持設定のアップデートが大きく影響しています。

ゴミ箱内のデータ保持期限が設定できるようになりました。操作できるのはエンタープライズプランのワークスペースオーナーのみです。エンタープライズプラン以外は強制で30日後に削除されるようになります。

デフォルトでは30日間。1日から10年までの変更が可能となります。ただし、有効になるのは2024年6月17日以降となっています。操作していなかった場合、2024年6月17日以前にゴミ箱入りしていたデータは2024年7月17日に削除されます。

削除されることによるメリットですが、検索結果からゴミ箱内の古いデータが自動で除外されることに繋がります。チームプランをお試しで使っている場合には、ゴミ箱が原因でデータ量上限に掛かる頻度を減らせるかもしれません。

APIへの変更反映

期限で強制削除されることにより、アーカイブではなくゴミ箱としての機能することになったためか、APIエンドポイントのパラメータ名が変わります。APIリファレンス内では既にarchivedで検索してもヒットしなくなっています。

ポイントは、archivedをin_trashに置き換えるだけで対処完了となる点です。必須パラメータではないので、APIリクエストのパラメータ内に設定していないケースが多いかもしれません。動作は変わらずゴミ箱への移動となります。以下、リファレンス内のサンプルコードです。

curl https://api.notion.com/v1/pages/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX \
  -H 'Authorization: Bearer '"$NOTION_API_KEY"'' \
  -H "Content-Type: application/json" \
  -H "Notion-Version: 2022-06-28" \
  -X PATCH \
    --data '{
    "in_trash": true
}'

あとがき

自動で削除するバッチを実施していた場合、archived指定が入っていたら対処しておきましょう。

これまでは置き場が悩ましい時にゴミ箱へ一時避難させる、といった使い方もありましたが、今後は専用にチームスペースを切るか、プライベートへの移動にしたほうが意図しないデータ消滅を防げるかもしれません。